<!doctype html>
<html lang="en">
<head>
    <title>API for class htmlWriter (phpAPI: PHP Documentation Creator version 6.0)</title>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
    <meta name="generator" content="phpAPI 6.0 (https://github.com/Greenray/phpAPI/)">
    <link rel="stylesheet" type="text/css" href="../style.css">
    <link rel="start" href="../index.html">
</head>
    <body id="htmlWriter" onload="parent.document.title=document.title;">
    <div class="header">
    <span style="float:right">phpAPI v6.0</span>
            <ul>
                    <li><a href="../overview-summary.html">Overview</a></li>
                    <li><a href="../html/package-summary.html">Namespace</a></li>
                    <li class="active">Class</li>
                    <li><a href="../html/package-tree.html">html\Tree</a></li>
                    <li><a href="../deprecated.html">Deprecated</a></li>
                    <li><a href="../todo.html">Todo</a></li>
                    <li><a href="../index-all.html">Index</a></li>
                </ul>
    </div>
<hr />
<div class="small_links">Frames: <a href="../index.html" target="_top"> On</a> | <a href="" target="_top"> Off</a></div>
<hr />
    <div class="small_links">
        <a href="#details_fields">Fields</a> | <a href="#details_methods">Methods</a> | <a href="#details_constructor">Constructor</a>
    </div>
    <hr />
<div class="package">Namespace html</div>
<h1>Class htmlWriter</h1>
<div id="list">
    <ul>
        <li><strong>htmlWriter</strong></li></ul></li>    </ul>
</div>
<hr />
<p class="arguments">public  class <strong>htmlWriter</strong></p>
<div class="comment" id="overview_description">Generates menu and writes html pages.</div>
<div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Program</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">phpapi: PHP Documentation Creator</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Version</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">6.0</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Author</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">Victor Nabatov greenray.spb@gmail.com</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Copyright</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">(c) 2015-2016 Victor Nabatov</td>
                    </tr>
            <tr>
            <td class="hid left w_100">License</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">Creative Commons Attribution-ShareAlike 4.0 International</td>
                    </tr>
            <tr>
            <td class="hid left w_100">File</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">/system/globalWriter.php</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Overview</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">HTML documentation generator.</td>
                    </tr>
        </table>
</div>
    <h2 id="details_fields">Fields</h2>
            <div class="location">system/htmlWriter.php at line 18</div>
        <pre class="arguments" id="depth">public  integer <strong><span class="green">$depth</span></strong> = 0;</pre>
        <div class="details">Directory structure depth. Used to calculate relative paths</div>
        <hr />
            <div class="location">system/htmlWriter.php at line 21</div>
        <pre class="arguments" id="doclet">public  doclet <strong><span class="green">$doclet</span></strong></pre>
        <div class="details">Doclet that created this object</div>
        <hr />
            <div class="location">system/htmlWriter.php at line 24</div>
        <pre class="arguments" id="id">public  string <strong><span class="green">$id</span></strong> = <span class="red">"overview"</span>;</pre>
        <div class="details">The <body> id attribute value, used for selecting style</div>
        <hr />
            <div class="location">system/htmlWriter.php at line 27</div>
        <pre class="arguments" id="items">public  string <strong><span class="green">$items</span></strong> = <span class="red">""</span>;</pre>
        <div class="details">List of package, functions, globals...</div>
        <hr />
            <div class="location">system/htmlWriter.php at line 30</div>
        <pre class="arguments" id="output">public  string <strong><span class="green">$output</span></strong> = <span class="red">""</span>;</pre>
        <div class="details">Output body</div>
        <hr />
            <div class="location">system/htmlWriter.php at line 32</div>
        <pre class="arguments" id="regexp">private  mixed <strong><span class="green">$regexp</span></strong> = [<br />        <span class="red">"#[\"</span>](.*?)[\<span class="red">"]#is"</span>     =&gt; <span class="red">"&lt;span class=<span class="red">"red"</span>&gt;<span class="red">"\\1"</span>&lt;/span&gt;"</span>,<br />        <span class="red">"#&amp;quot;(.*?)&amp;quot;#is"</span> =&gt; <span class="red">"&lt;span class=<span class="red">"red"</span>&gt;<span class="red">"\\1"</span>&lt;/span&gt;"</span>,<br />        <span class="red">"#[\<span class="red">"](.*?)[\"</span>]#is"</span>     =&gt; <span class="red">"&lt;span class=<span class="red">"red"</span>&gt;<span class="red">"\\1"</span>&lt;/span&gt;"</span>,<br />        <span class="red">"#&lt;a(.*)&gt;(.*?)&lt;/a&gt;#is"</span>  =&gt; <span class="red">"\\2"</span><br />    ];</pre>
        <div class="details">No description</div>
        <hr />
            <div class="location">system/htmlWriter.php at line 35</div>
        <pre class="arguments" id="sections">public  array <strong><span class="green">$sections</span></strong> = [];</pre>
        <div class="details">Section titles to place in the header</div>
        <hr />
        <h2 id="details_methods">Methods</h2>
            <div class="location">system/htmlWriter.php at line 42</div>
        <code class="arguments" id="htmlWriter">public  void <strong>htmlWriter</strong> (<span class="lilac">doclet</span> <span class="blue">&$doclet</span>)</code>
        <div class="details">
                    <p class="description">Constructor.</p>
            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">doclet</td>
                            <td class="hid blue w_100">&$doclet</td>
                <td class="hid">Reference to documentation generator</td>
                    </tr>
        </table>
</div>
        </div>
        <hr />
            <div class="location">system/htmlWriter.php at line 53</div>
        <code class="arguments" id="nav">public  string <strong>nav</strong> (<span class="lilac">string</span> <span class="blue">$path</span>, <span class="lilac">string</span> <span class="blue">$file</span>)</code>
        <div class="details">
                    <p class="description">Builds the navigation bar.</p>
            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$path</td>
                <td class="hid">Path to write the file to</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$file</td>
                <td class="hid">Filename for which navigation to create (default = <span class="red">""</span>)</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Return</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid" colspan="2">Navigation for documentation</td>
                    </tr>
        </table>
</div>
        </div>
        <hr />
            <div class="location">system/htmlWriter.php at line 89</div>
        <code class="arguments" id="packageItems">public  string <strong>packageItems</strong> (<a href="../phpapi/phpapi.html">phpapi</a> <span class="blue">&$phpapi</span>, <a href="../phpapi/packagedoc.html">packageDoc</a> <span class="blue">&$package</span>)</code>
        <div class="details">
                    <p class="description">Builds all items of the class.</p>
            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac"><a href="../phpapi/phpapi.html">phpapi</a></td>
                            <td class="hid blue w_100">&$phpapi</td>
                <td class="hid">Reference to the application object</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac"><a href="../phpapi/packagedoc.html">packageDoc</a></td>
                            <td class="hid blue w_100">&$package</td>
                <td class="hid">Reference to the current package</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Return</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid" colspan="2">Parsed template <span class="red">"class-items"</span></td>
                    </tr>
        </table>
</div>
        </div>
        <hr />
            <div class="location">system/htmlWriter.php at line 184</div>
        <code class="arguments" id="processInlineTags">protected  string <strong>processInlineTags</strong> (<a href="../tags/tag.html">tag</a> <span class="blue">&$tag</span>, <span class="lilac">boolean</span> <span class="blue">$first</span>)</code>
        <div class="details">
                    <p class="description">Converts inline tags into a string for outputting.</p>
            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac"><a href="../tags/tag.html">tag</a></td>
                            <td class="hid blue w_100">&$tag</td>
                <td class="hid">Object reference</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">boolean</td>
                            <td class="hid blue w_100">$first</td>
                <td class="hid">Process first line of comment only</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Return</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid" colspan="2">String representation of the elements doc tags</td>
                    </tr>
        </table>
</div>
        </div>
        <hr />
            <div class="location">system/htmlWriter.php at line 211</div>
        <code class="arguments" id="parameters">protected  array <strong>parameters</strong> (<a href="../tags/tag.html">tag</a> <span class="blue">&$tag</span>, <span class="lilac">object</span> <span class="blue">$obj</span>, <span class="lilac">mixed</span> <span class="blue">&$tags</span>)</code>
        <div class="details">
                    <p class="description">Formats parameters for output.<br /> Returns the list of parameters with their types.<br /> Recognised types are turned into HTML anchor tags to the documentation page for the class defining them.</p>
            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac"><a href="../tags/tag.html">tag</a></td>
                            <td class="hid blue w_100">&$tag</td>
                <td class="hid">Object reference</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">object</td>
                            <td class="hid blue w_100">$obj</td>
                <td class="hid">Currently processed object</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Return</td>
            <td class="hid right w_100 lilac">array</td>
                            <td class="hid" colspan="2">Text representation of the parameters</td>
                    </tr>
        </table>
</div>
        </div>
        <hr />
            <div class="location">system/htmlWriter.php at line 292</div>
        <code class="arguments" id="showObject">public  array <strong>showObject</strong> (<span class="lilac">object</span> <span class="blue">$object</span>)</code>
        <div class="details">
                    <p class="description">Preparation of the object for html template.</p>
            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">object</td>
                            <td class="hid blue w_100">$object</td>
                <td class="hid">Object (fields, methods, constants, variables...)</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Return</td>
            <td class="hid right w_100 lilac">array</td>
                            <td class="hid" colspan="2">Result</td>
                    </tr>
        </table>
</div>
        </div>
        <hr />
            <div class="location">system/htmlWriter.php at line 334</div>
        <code class="arguments" id="write">public  void <strong>write</strong> (<span class="lilac">string</span> <span class="blue">$file</span>, <span class="lilac">string</span> <span class="blue">$title</span>, <span class="lilac">boolean</span> <span class="blue">$menu</span>)</code>
        <div class="details">
                    <p class="description">Writes the HTML page to disk using the given path.</p>
            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$file</td>
                <td class="hid">Path to write the file to</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$title</td>
                <td class="hid">Title for new page</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">boolean</td>
                            <td class="hid blue w_100">$menu</td>
                <td class="hid">To place the menu on the page</td>
                    </tr>
        </table>
</div>
        </div>
        <hr />
        <div class="header">
    <span style="float:right">phpAPI v6.0</span>
            <ul>
                    <li><a href="../overview-summary.html">Overview</a></li>
                    <li><a href="../html/package-summary.html">Namespace</a></li>
                    <li class="active">Class</li>
                    <li><a href="../html/package-tree.html">html\Tree</a></li>
                    <li><a href="../deprecated.html">Deprecated</a></li>
                    <li><a href="../todo.html">Todo</a></li>
                    <li><a href="../index-all.html">Index</a></li>
                </ul>
    </div>
<hr />
<div class="small_links">Frames: <a href="../index.html" target="_top"> On</a> | <a href="" target="_top"> Off</a></div>
<hr />
    <div class="small_links">
        <a href="#details_fields">Fields</a> | <a href="#details_methods">Methods</a> | <a href="#details_constructor">Constructor</a>
    </div>
    </body>
</html>
